home *** CD-ROM | disk | FTP | other *** search
/ Acorn User: China / Acorn User China CD-ROM (UK) (Disc A) / Acorn User China CD-ROM (UK) (Disc A).bin / HENSA / FILE / SQUISH.ARC / !Squish_!Help_HelpText < prev    next >
Encoding:
Text File  |  1994-09-06  |  6.7 KB  |  154 lines

  1. Squish version 2.42 Help
  2. ------------------------
  3.  
  4. Squish is a compression program, it uses variations of the Byte & Counter method of Compression.  It is best used for screens and sprites.
  5.  
  6. To use, drag the Sprite file to the icon, on the iconbar.  A savebox will then pop up and you can save in the standard RISC OS manner.  The output file will have the Filetype 156 : "Squished".
  7.  
  8. To decompact the file just drag the squished file to the icon and it will save as a sprite.
  9.  
  10. Description of the Menus & Windows
  11. ----------------------------------
  12.  
  13. The Main menu has the following options:
  14.  
  15. Info    - The common info window 
  16. Options - Produces the options window; see below 
  17. Quit    - Quits the program
  18.  
  19. The Options window has the following options:
  20.  
  21. Sprite Header   - refers to whether the compressed input file is a
  22.                 compressed screen or a compressed spritefile.  It has a
  23.                 default value of on, ie the file is a sprite.
  24.  
  25. Mode            - Greyed-out unless Sprite Header is clicked off. This
  26.                 refers to the screen mode which the screen has being saved
  27.                 in. Default value 13.
  28.  
  29. Squish Header   - Refers to a byte header, telling the program which
  30.                 algorithm is used.  It is advised to leave this option on,
  31.                 unless decompacting sprites from games. Default ON.
  32.  
  33. Byte & Counter  - Tells the program to decompress and to compress as Byte
  34.                 and Counter.
  35.  
  36. Modification    - Tells the program to decompress using the Byte & Counter
  37.                 Modification (Found in games such as Superpool, 2067 BC)
  38.  
  39. Counter & Byte  - Tells the program to decompress and to compress as Counter
  40.                 and Byte.                                            
  41.  
  42. Modification    - Tells the program to compress using the Lodge Modification
  43.                 (derived by Me!)
  44.  
  45. Lempel-Ziv-Welch- Tells the program to use the LZW alogorithm. This is not
  46.                 currently supported in this version.
  47.  
  48. Huffman Encoding- Tells the program to use Huffman Encoding. This is not
  49.                 currently supported in this version.
  50.  
  51. The default method is the Byte & Counter Algorithm
  52.  
  53. Compression Algorithms
  54. ----------------------
  55.  
  56. Byte then Counter (aka Run Length Encoding): The simplest form of compaction. The routine takes a byte from the file and finds how many time this is replicated. It then stores the byte and then the amount of times it occurs (ie the counter)
  57.  
  58. Counter then Byte: Like byte then counter, but the counter is stored before the byte.
  59.  
  60. Key Modification: Primarily a byte and counter method, but if a byte is found by itself, it is put straight to the disc, if a byte replicates, then the byte is put TWICE to the disc, followed by the counter. Note: not as yet avaiable to compress, instead, the program will use normal byte and counter.
  61.  
  62. Lodge Modification: Primarily a counter and byte method, but if more than two bytes which are NOT equal are found then they are put to the disc, prefixed and suffixed by a CHR$255 (ie ÿ).  This imposes a limit on the counter ie 254.                                        
  63.  
  64. File format
  65. -----------
  66.  
  67. With header: 1 byte to tell algorithm:  0 - Byte and Counter
  68.                                         1 - Counter and Byte
  69.                                         2 - Key Modification
  70.                                         3 - Lodge Modification
  71.  
  72. Using this program in other programs
  73. ------------------------------------
  74.  
  75. Use the 'SquishMod' module SWIs as documented in the 'Tech' file in the program directory.  
  76.  
  77. Riscy Developments (Dave Lodge / Ian Jeffray) accept no responsibility for the consequences of using this module : Use it as you wish : we don't really care!
  78.  
  79. Other points to note
  80. --------------------
  81.  
  82. Certain games have used a similar compression technique (for all these files, Squish header should be turned OFF):
  83.         
  84.         Nevryon: All files in the '1','2','3' and '4', called 'SHIPS' or 'SHIPS2' are compressed by a very similar technique, to decompress them and get the sprite files out, just change the filetype and drag them onto the !Squish icon, the resulting file will be a Sprite file, which you can load into Paint and mess around with.  Most of the files in the PIX directory, can be dragged into the program, but you must ensure that the option "Sprite Header" is clicked OFF.
  85.  
  86.         Saloon Cars Deluxe: There are various Byte & Counter compressed pictures in this, eg the map files in the Track directories.  You must ensure the the option "Sprite Header" is clicked OFF.
  87.  
  88.         2067 BC: All files in the Graphix directory, with the filetype &CCC (dietsprite) can be dragged straight into Squish, and will be converted.
  89.  
  90.         TBVG: As above.
  91.  
  92.         SuperPool, Break 147: All files in the !DeData.SCNSHOTS directory can be converted. These are stored using a variant of the Key Modification (which v2.42 of Squish can understand). To decompact them, filetype them to &CCC (dietsprite), and drag them into Squish. As they are all screens without the sprite header, it is advised to switch the Sprite Header option off.
  93.  
  94.  
  95. Version Updates
  96. ---------------
  97.  
  98. v1.00   Original Icon Bar version
  99.  
  100. v2.00   Rewritten, with menus, info window and save box
  101.  
  102. v2.10   Rewritten with option window
  103.  
  104. v2.20   Diet Sprite compatibility offered
  105.  
  106. v2.21   Fix to stop crashing upon finding a null counter
  107.  
  108. v2.22   Doesn't crash with files which the output file turns out larger than
  109.         160k
  110.  
  111. v2.30   'Lodge' Modification added for better compression.
  112.  
  113. v2.31   Header added to Squish file: 1 byte = Method
  114.  
  115. v2.32   Adaption to Key modification to allow it to read Super Pool
  116.         Graphics and bug fix for loading screens more than current screen
  117.         memory.
  118.  
  119. v2.40   Module coded and added to program (Thanks Ian!)
  120.  
  121. v2.41   Module now used to fill Icons
  122.  
  123. v2.42   Compression now occurs when saving rather than loading.
  124.  
  125.  
  126. Contacts
  127. --------
  128.  
  129. If you want to contact me in any way, shape or form, or for any reason, then contact me at the addresses below:
  130.  
  131. Holidays:       Dave Lodge 
  132.                 26 Cleveland Way
  133.                 Carlton Miniott
  134.                 Thirsk
  135.                 N. Yorks.
  136.                 YO7 4LN
  137.  
  138.  
  139. Please enclose a SAE, if you expect a reply (I'm only a Student).   Money, and offers of Alcoholic Beverages gratefully accepted!
  140.  
  141.           Squish version 2.42 by Dave Lodge of Riscy Developments
  142.                     (F) Floppyright 4th October 1992
  143.  
  144.  
  145. PS      Look out for more Riscy Developments programs at your local PD
  146.         library.  We might actually get around to finishing writing our High
  147.         Score Editor one day!
  148.  
  149. PPS     I am sorry about the Riscy Developments sprite on the info window
  150.         being done in mode 27, but if you can't afford a multisync monitor,
  151.         tough!
  152.  
  153.  
  154. Edited by Ian Jeffray 7/9/94